Sign Up

You can sign up as an individual client or a corporate client. The sign up procedures for the individual client differ from that of the corporate client.

The endpoint below POST /api/v1/auth/signup is used to sign up.

authorization : bearer token

refer to authentication

REQUEST BODY SCHEMA : application/json

Individual Client

email	string Email of the client
country required	string Country of the client
city	string The name of the city where the client (individual/company) is located
region	string Region/State name
digitalAddress	string Digital address (Ghana Post GPS address) of the client
password	string >= 5 characters Account password
industry	string Industry of the client
address	string Address of the client
notes	string Additional notes about the client
type required	string Enum: "CORPORATE" "INDIVIDUAL" The type of client
groups required	Array of strings Default: [] List of groups the client belongs to
profileImage	object <binary> Profile picture
firstName	string Client first name. Required if client is INDIVIDUAL
lastName	string Client last name. Required if client is INDIVIDUAL
otherNames	string Middle or other names (if any)
title	string
gender	string Enum: "MALE" "FEMALE" "OTHER"
dateOfBirth	string
	object (ClientIdentificationCardDto)
taxpayerIdentificationNumber	string
phoneNumber	string [ 10 .. 15 ] characters
isActive	boolean

{

• "email": "user@example.com",
• "country": "Ghana",
• "city": "Accra",
• "region": "Greater Accra",
• "digitalAddress": "CC-1334-332",
• "password": "password",
• "industry": "Agriculture",
• "address": "Dansoman Street 12, Accra, Ghana",
• "notes": "lorem ipusom",
• "type": "CORPORATE",
• "groups": [

  • "63403be1567f7e1f11c58bd6",
  • "63403b8a088f7a3cd5f8e717"

  ],
• "profileImage": { },
• "firstName": "John",
• "lastName": "Doe",
• "otherNames": "Wood",
• "title": "Mr",
• "gender": "Male",
• "dateOfBirth": "string",
• "identificationCard": {

  • "idNumber": "123456789",
  • "type": "GHANA_CARD",
  • "issueDate": "string",
  • "expiryDate": "string"

  },
• "taxpayerIdentificationNumber": "string",
• "phoneNumber": "stringstri",
• "isActive": true

}

Corporate Client

companyName	string Company name. Required if client type is CORPORATE
email	string Email of the client
country required	string Country of the client
city	string The name of the city where the client (individual/company) is located
region	string Region/State name
digitalAddress	string Digital address (Ghana Post GPS address) of the client
password	string >= 5 characters Account password
industry	string Industry of the client
address	string Address of the client
notes	string Additional notes about the client
dateOfIncorporation	string Date the company was incorporated
type required	string Enum: "CORPORATE" "INDIVIDUAL" The type of client
groups required	Array of strings Default: [] List of groups the client belongs to
	Array of objects (ContactPersonDto) Contact persons details
profileImage	object <binary> Profile picture
taxpayerIdentificationNumber	string
phoneNumber	string [ 10 .. 15 ] characters
isActive	boolean

{

• "companyName": "ABC Company",
• "email": "user@example.com",
• "country": "Ghana",
• "city": "Accra",
• "region": "Greater Accra",
• "digitalAddress": "CC-1334-332",
• "password": "password",
• "industry": "Agriculture",
• "address": "Dansoman Street 12, Accra, Ghana",
• "notes": "lorem ipusom",
• "dateOfIncorporation": "2006-12-15",
• "type": "CORPORATE",
• "groups": [

  • "63403be1567f7e1f11c58bd6",
  • "63403b8a088f7a3cd5f8e717"

  ],
• "contactPersons": [

  • {

    • "phoneNumber": "+233248023456",
    • "email": "user@example.com",
    • "position": "Sales Manager",
    • "name": "string"

    }

  ],
• "profileImage": { },
• "taxpayerIdentificationNumber": "string",
• "phoneNumber": "stringstri",
• "isActive": true

}

---

User Types

• Individual Client
  A person can sign up on the insurerity platform. The information needed to sign up as an individual client are listed below.

email	string Email of the client
country required	string Country of the client
city	string The name of the city where the client (individual/company) is located
region	string Region/State name
digitalAddress	string Digital address (Ghana Post GPS address) of the client
password	string >= 5 characters Account password
industry	string Industry of the client
address	string Address of the client
notes	string Additional notes about the client
type required	string Enum: "CORPORATE" "INDIVIDUAL" The type of client
groups required	Array of strings Default: [] List of groups the client belongs to
profileImage	object <binary> Profile picture
firstName	string Client first name. Required if client is INDIVIDUAL
lastName	string Client last name. Required if client is INDIVIDUAL
otherNames	string Middle or other names (if any)
title	string
gender	string Enum: "MALE" "FEMALE" "OTHER"
dateOfBirth	string
	object (ClientIdentificationCardDto)
taxpayerIdentificationNumber	string
phoneNumber	string [ 10 .. 15 ] characters
isActive	boolean

{

• "email": "user@example.com",
• "country": "Ghana",
• "city": "Accra",
• "region": "Greater Accra",
• "digitalAddress": "CC-1334-332",
• "password": "password",
• "industry": "Agriculture",
• "address": "Dansoman Street 12, Accra, Ghana",
• "notes": "lorem ipusom",
• "type": "CORPORATE",
• "groups": [

  • "63403be1567f7e1f11c58bd6",
  • "63403b8a088f7a3cd5f8e717"

  ],
• "profileImage": { },
• "firstName": "John",
• "lastName": "Doe",
• "otherNames": "Wood",
• "title": "Mr",
• "gender": "Male",
• "dateOfBirth": "string",
• "identificationCard": {

  • "idNumber": "123456789",
  • "type": "GHANA_CARD",
  • "issueDate": "string",
  • "expiryDate": "string"

  },
• "taxpayerIdentificationNumber": "string",
• "phoneNumber": "stringstri",
• "isActive": true

}

• Corporate Client
  Insurance brokers, insurance and Microinsurance companies can sign up on insurerity platforms. The information needed to sign up as a corporate client are listed below.

companyName	string Company name. Required if client type is CORPORATE
email	string Email of the client
country required	string Country of the client
city	string The name of the city where the client (individual/company) is located
region	string Region/State name
digitalAddress	string Digital address (Ghana Post GPS address) of the client
password	string >= 5 characters Account password
industry	string Industry of the client
address	string Address of the client
notes	string Additional notes about the client
dateOfIncorporation	string Date the company was incorporated
type required	string Enum: "CORPORATE" "INDIVIDUAL" The type of client
groups required	Array of strings Default: [] List of groups the client belongs to
	Array of objects (ContactPersonDto) Contact persons details
profileImage	object <binary> Profile picture
taxpayerIdentificationNumber	string
phoneNumber	string [ 10 .. 15 ] characters
isActive	boolean

{

• "companyName": "ABC Company",
• "email": "user@example.com",
• "country": "Ghana",
• "city": "Accra",
• "region": "Greater Accra",
• "digitalAddress": "CC-1334-332",
• "password": "password",
• "industry": "Agriculture",
• "address": "Dansoman Street 12, Accra, Ghana",
• "notes": "lorem ipusom",
• "dateOfIncorporation": "2006-12-15",
• "type": "CORPORATE",
• "groups": [

  • "63403be1567f7e1f11c58bd6",
  • "63403b8a088f7a3cd5f8e717"

  ],
• "contactPersons": [

  • {

    • "phoneNumber": "+233248023456",
    • "email": "user@example.com",
    • "position": "Sales Manager",
    • "name": "string"

    }

  ],
• "profileImage": { },
• "taxpayerIdentificationNumber": "string",
• "phoneNumber": "stringstri",
• "isActive": true

}

Request Sample

email	string Email of the client
country required	string Country of the client
city	string The name of the city where the client (individual/company) is located
region	string Region/State name
digitalAddress	string Digital address (Ghana Post GPS address) of the client
password	string >= 5 characters Account password
industry	string Industry of the client
address	string Address of the client
notes	string Additional notes about the client
type required	string Enum: "CORPORATE" "INDIVIDUAL" The type of client
groups required	Array of strings Default: [] List of groups the client belongs to
profileImage	object <binary> Profile picture
firstName	string Client first name. Required if client is INDIVIDUAL
lastName	string Client last name. Required if client is INDIVIDUAL
otherNames	string Middle or other names (if any)
title	string
gender	string Enum: "MALE" "FEMALE" "OTHER"
dateOfBirth	string
	object (ClientIdentificationCardDto)
taxpayerIdentificationNumber	string
phoneNumber	string [ 10 .. 15 ] characters
isActive	boolean

{

• "email": "user@example.com",
• "country": "Ghana",
• "city": "Accra",
• "region": "Greater Accra",
• "digitalAddress": "CC-1334-332",
• "password": "password",
• "industry": "Agriculture",
• "address": "Dansoman Street 12, Accra, Ghana",
• "notes": "lorem ipusom",
• "type": "CORPORATE",
• "groups": [

  • "63403be1567f7e1f11c58bd6",
  • "63403b8a088f7a3cd5f8e717"

  ],
• "profileImage": { },
• "firstName": "John",
• "lastName": "Doe",
• "otherNames": "Wood",
• "title": "Mr",
• "gender": "Male",
• "dateOfBirth": "string",
• "identificationCard": {

  • "idNumber": "123456789",
  • "type": "GHANA_CARD",
  • "issueDate": "string",
  • "expiryDate": "string"

  },
• "taxpayerIdentificationNumber": "string",
• "phoneNumber": "stringstri",
• "isActive": true

}

Response Sample

id required	string Unique ID of the record
createdAt required	string <date-time> Date & time at which the record was created
updatedAt required	string <date-time> Date & time at which the record was updated
companyName	string Company name. Required if client type is CORPORATE
email	string Email of the client
country required	string Country of the client
city	string The name of the city where the client (individual/company) is located
region	string Region/State name
digitalAddress	string Digital address (Ghana Post GPS address) of the client
password	string >= 5 characters Account password
industry	string Industry of the client
address	string Address of the client
notes	string Additional notes about the client
dateOfIncorporation	string Date the company was incorporated
type required	string Enum: "CORPORATE" "INDIVIDUAL" The type of client
groups required	Array of strings Default: [] List of groups the client belongs to
	Array of objects (ContactPersonDto) Contact persons details
firstName	string Client first name. Required if client is INDIVIDUAL
lastName	string Client last name. Required if client is INDIVIDUAL
otherNames	string Middle or other names (if any)
title	string
gender	string Enum: "MALE" "FEMALE" "OTHER"
age	number The age of the client, calculated from the date of birth. null if the client is CORPORATE
fullName required	string Client full name
isActive	boolean Whether client account is active or has been deactivated
	Array of objects (DeliveryAddressResponseDto) Default: [] Client Delivery Addresses
	object Profile picture
required	Array of objects (UserNotificationResponseDto) Default: [] Notifications of the client
taxpayerIdentificationNumber	string
phoneNumber	string [ 10 .. 15 ] characters
dateOfBirth	string
	object (ClientIdentificationCardDto)

{

• "id": "619c0911b46b424f5f3e470f",
• "createdAt": "2020-05-05T00:00:00.000Z",
• "updatedAt": "2020-05-05T00:00:00.000Z",
• "companyName": "ABC Company",
• "email": "user@example.com",
• "country": "Ghana",
• "city": "Accra",
• "region": "Greater Accra",
• "digitalAddress": "CC-1334-332",
• "password": "password",
• "industry": "Agriculture",
• "address": "Dansoman Street 12, Accra, Ghana",
• "notes": "lorem ipusom",
• "dateOfIncorporation": "2006-12-15",
• "type": "CORPORATE",
• "groups": [

  • "63403be1567f7e1f11c58bd6",
  • "63403b8a088f7a3cd5f8e717"

  ],
• "contactPersons": [

  • {

    • "phoneNumber": "+233248023456",
    • "email": "user@example.com",
    • "position": "Sales Manager",
    • "name": "string"

    }

  ],
• "firstName": "John",
• "lastName": "Doe",
• "otherNames": "Wood",
• "title": "Mr",
• "gender": "Male",
• "age": 25,
• "fullName": "John Wood Doe",
• "isActive": true,
• "deliveryAddresses": [ ],
• "profileImage": {

  • "id": "619c0911b46b424f5f3e470f",
  • "createdAt": "2020-01-01T00:00:00.000Z",
  • "updatedAt": "2020-05-05T00:00:00.000Z",
  • "contentType": "image/jpeg",
  • "url": "https://1d16-156-38-117-143.eu.ngrok.io/api/v1/documents/afae4c2bbd5e_programme-jokes.jpeg",
  • "size": "12345",
  • "name": "file-name.jpg"

  },
• "notifications": [ ],
• "taxpayerIdentificationNumber": "string",
• "phoneNumber": "stringstri",
• "dateOfBirth": "string",
• "identificationCard": {

  • "idNumber": "123456789",
  • "type": "GHANA_CARD",
  • "issueDate": "string",
  • "expiryDate": "string"

  }

}